API

Logistics APIs

GET logistics/shipping-advice-items

List of all shipping advice items

HTTP method GET
URI https://api.rambase.net/logistics/shipping-advice-items
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2696, version 32

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ApprovalNotification() Named filter Shipping advices with notifications of category A (Approval) in status 2 or 3
InfoNotification() Named filter Shipping advice items with notification of category I (Information)
MyItems() Named filter Items which belong to a shipping advice the current user is either assigned to, sales assistent for or account manager for.
AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer. Available macros: currentUser()
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
ContainingNotificationTypeId Integer Notification type identifier.
ConvertedGrossAmount Decimal Total gross amount in company currency.
ConvertedGrossPrice Decimal Represents the price per unit before any discounting is applied.
ConvertedNetAmount Decimal Total net amount in company currency.
ConvertedNetPrice Decimal Final price per unit after deducting all discounts.
ConvertedRemainingAmount Decimal Total remaining amount in company currency.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
CustomerFirstname String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
DeliveryTerms String Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.
DepartmentId Integer Department identifier.
Discount Decimal The discount for the item.
DiscountAmount Decimal The items discount amount.
DiscountPercent Decimal The discount in percent for this item.
EndCustomerFirstName String Secondary name of a company or firstname of a person.
EndCustomerId Integer Customer identifier.
EndCustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
EquivalentProductName String Name of product with equivalent behavior and attributes. Can be used for same purpose..
FinanceProjectId Integer Finance project identifier.
GeneralLedgerAccountId Integer General ledger account identifier.
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossMargin Decimal Gross margin of the item.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
IsPaymentCoveredByWarranty Boolean True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.
IsSerialNumberRequiredBeforeShipping Boolean True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
LocationShortName String Unique abbreviation/short name of the location.
ManufacturerId Integer Manufacturer identifier.
ManufacturerShortName String Shortname/code of the manufacturer.
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity of the shipping advice item.
RemainingAmount Decimal Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice.
RemainingQuantity Decimal Remaining number of units to be forwarded.
RequestedProductStructureRevision String The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
SalesAssistant Integer Reference to the employee who is sales assistant for the customer. Available macros: currentUser()
ScheduledShippingDate Date Date when the goods was/will be shipped from the warehouse. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SellersReferenceNumber String Sellers reference number..
ShippingAdviceId Integer Shipping advice identifier.
ShippingAdviceItemId Integer Item-/line-number of the shipping advice.
Status Integer Status of the shipping advice item (0-9).
WarrantyExpirationDate Date Date of warranty expiration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

Read more about filters and sorting on how to use sortable parameters

AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer.
Assignee Integer The user who has been assigned to work with this object.
ContainingNotificationTypeId Integer Notification type identifier
ConvertedGrossAmount Decimal Total gross amount in company currency.
ConvertedGrossPrice Decimal Represents the price per unit before any discounting is applied.
ConvertedNetAmount Decimal Total net amount in company currency.
ConvertedNetPrice Decimal Final price per unit after deducting all discounts.
ConvertedRemainingAmount Decimal Total remaining amount in company currency.
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
CustomerFirstname String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
DeliveryTerms String Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.
DepartmentId Integer Department identifier
Discount Decimal The discount for the item.
DiscountAmount Decimal The items discount amount.
DiscountPercent Decimal The discount in percent for this item.
EndCustomerFirstName String Secondary name of a company or firstname of a person
EndCustomerId Integer Customer identifier
EndCustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
EquivalentProductName String Name of product with equivalent behavior and attributes. Can be used for same purpose.
FinanceProjectId Integer Finance project identifier
GeneralLedgerAccountId Integer General ledger account identifier
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossMargin Decimal Gross margin of the item.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
IsPaymentCoveredByWarranty Boolean True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.
IsSerialNumberRequiredBeforeShipping Boolean True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
LocationShortName String Unique abbreviation/short name of the location
ManufacturerId Integer Manufacturer identifier
ManufacturerShortName String Shortname/code of the manufacturer
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal Quantity of the shipping advice item
RemainingAmount Decimal Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
RemainingQuantity Decimal Remaining number of units to be forwarded.
RequestedProductStructureRevision String The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
SalesAssistant Integer Reference to the employee who is sales assistant for the customer.
ScheduledShippingDate Date Date when the goods was/will be shipped from the warehouse
SellersReferenceNumber String Sellers reference number.
ShippingAdviceId Integer Shipping advice identifier
ShippingAdviceItemId Integer Item-/line-number of the shipping advice
Status Integer Status of the shipping advice item (0-9)
WarrantyExpirationDate Date Date of warranty expiration.

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ShippingAdviceItems>
2
     <ShippingAdviceItem>
3
          <ShippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

>{Integer}</ShippingAdviceItemId>
4
          <Status
Status

Status of the shipping advice item (0-9)

Possible domain values can be found here

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <LineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

>{Integer}</LineNumber>
7
          <ScheduledShippingDate
ScheduledShippingDate

Date when the goods was/will be shipped from the warehouse.

>{Date}</ScheduledShippingDate>
8
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
9
          <CustomersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

>{String}</CustomersProductName>
10
          <RequestedProductStructureRevision
RequestedProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>{String}</RequestedProductStructureRevision>
11
          <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

>{String}</ProductDescription>
12
          <GrossMargin
GrossMargin

Gross margin of the item.

>{Decimal}</GrossMargin>
13
          <DiscountPercent
DiscountPercent

The discount in percent for this item.

>{Decimal}</DiscountPercent>
14
          <Quantity
Quantity

Quantity of the shipping advice item

>{Decimal}</Quantity>
15
          <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

>{Decimal}</RemainingQuantity>
16
          <EndCustomer
EndCustomer

End customer

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

>
17
               <CustomerId
CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

>{Integer}</CustomerId>
18
               <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

>{String}</Name>
19
               <FirstName
FirstName

Secondary name of a company or firstname of a person

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

>{String}</FirstName>
20
               <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

>{String}</VATRegistrationNumber>
21
               <CustomerLink
CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

>{String}</CustomerLink>
22
          </EndCustomer>
23
          <Price>
24
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
25
               <Discount
Discount

The discount for the item.

>{Decimal}</Discount>
26
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
27
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
28
          </Price>
29
          <PriceConverted
PriceConverted

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.PriceConverted in your request URI to get this field

>
30
               <Currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.PriceConverted in your request URI to get this field

>{String}</Currency>
31
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.PriceConverted in your request URI to get this field

>{Decimal}</GrossPrice>
32
               <NetPrice
NetPrice

Final price per unit after deducting all discounts.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.PriceConverted in your request URI to get this field

>{Decimal}</NetPrice>
33
          </PriceConverted>
34
          <Totals>
35
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
36
               <DiscountAmount
DiscountAmount

The items discount amount.

>{Decimal}</DiscountAmount>
37
               <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>
38
               <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
39
               <RemainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

>{Decimal}</RemainingAmount>
40
          </Totals>
41
          <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

>
42
               <Currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

>{String}</Currency>
43
               <GrossAmount
GrossAmount

Total gross amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

>{Decimal}</GrossAmount>
44
               <NetAmount
NetAmount

Total net amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

>{Decimal}</NetAmount>
45
               <RemainingAmount
RemainingAmount

Total remaining amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

>{Decimal}</RemainingAmount>
46
          </TotalsConverted>
47
          <MeasurementUnit>
48
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>
49
               <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
50
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
51
          </MeasurementUnit>
52
          <Product>
53
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
54
               <Name
Name

Name of the product

>{String}</Name>
55
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
56
               <Manufacturer>
57
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
58
                    <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
59
               </Manufacturer>
60
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
61
          </Product>
62
          <LandedCost>
63
               <GrossPrice
GrossPrice

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

>{Decimal}</GrossPrice>
64
               <PurchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

>{Decimal}</PurchaseExchangeRate>
65
          </LandedCost>
66
          <LandedCostConverted
LandedCostConverted

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.LandedCostConverted in your request URI to get this field

>
67
               <GrossPrice
GrossPrice

Total cost (landed cost or true cost) in sales currency

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.LandedCostConverted in your request URI to get this field

>{Decimal}</GrossPrice>
68
          </LandedCostConverted>
69
          <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>
70
               <GeneralLedgerAccount
GeneralLedgerAccount

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>
71
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>{Integer}</GeneralLedgerAccountId>
72
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>{String}</GeneralLedgerAccountLink>
73
               </GeneralLedgerAccount>
74
               <Department
Department

The department related to the item. One of the system/fixed account dimensions.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>
75
                    <DepartmentId
DepartmentId

Department identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>{Integer}</DepartmentId>
76
                    <DepartmentLink
DepartmentLink

Finance department reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>{String}</DepartmentLink>
77
               </Department>
78
               <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>
79
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>{Integer}</FinanceProjectId>
80
                    <FinanceProjectLink
FinanceProjectLink

Finance project reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

>{String}</FinanceProjectLink>
81
               </FinanceProject>
82
          </Accounting>
83
          <HighlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>
84
               <NotificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{Integer}</NotificationId>
85
               <Status
Status

Status of the notification

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{Integer}</Status>
86
               <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{Datetime}</CreatedAt>
87
               <Message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{String}</Message>
88
               <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{String}</TranslatedMessage>
89
               <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>
90
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeId>
91
                    <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{String}</Category>
92
                    <NotificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeLink>
93
               </NotificationType>
94
               <NotificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{String}</NotificationLink>
95
          </HighlightedNotification>
96
          <ShippingAdvice>
97
               <ShippingAdviceId
ShippingAdviceId

Shipping advice identifier

>{Integer}</ShippingAdviceId>
98
               <Type
Type

Type of shipping advice. Gives an indication of what this shipping advice is based on or forwarded from.

Possible domain values can be found here

>{String}</Type>
99
               <Customer>
100
                    <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
101
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
102
                    <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
103
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
104
               </Customer>
105
               <ShippingAdviceLink
ShippingAdviceLink

Shipping advice reference

>{String}</ShippingAdviceLink>
106
          </ShippingAdvice>
107
          <Rental
Rental

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Rental in your request URI to get this field

>
108
               <SerialNumberSpecification
SerialNumberSpecification

For shipping advice items of type RENTALORDER, each item can have a serial number specified.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Rental in your request URI to get this field

>
109
                    <SerialNumber
SerialNumber

Serial number

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Rental in your request URI to get this field

>{String}</SerialNumber>
110
               </SerialNumberSpecification>
111
          </Rental>
112
          <ShippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

>{String}</ShippingAdviceItemLink>
113
     </ShippingAdviceItem>
114
     <Paging
Paging

Detailed paging information for this list.

>
115
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
116
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
117
          <Page
Page

Page index

>{Integer}</Page>
118
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
119
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
120
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
121
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
122
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
123
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
124
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
125
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
126
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
127
     </Paging>
128
</ShippingAdviceItems>
1
{
2
     "shippingAdviceItems": [
3
          {
4
               "shippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

": "{Integer}",
5
               "status
Status

Status of the shipping advice item (0-9)

Possible domain values can be found here

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "lineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

": "{Integer}",
8
               "scheduledShippingDate
ScheduledShippingDate

Date when the goods was/will be shipped from the warehouse.

": "{Date}",
9
               "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
10
               "customersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

": "{String}",
11
               "requestedProductStructureRevision
RequestedProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

": "{String}",
12
               "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
13
               "grossMargin
GrossMargin

Gross margin of the item.

": "{Decimal}",
14
               "discountPercent
DiscountPercent

The discount in percent for this item.

": "{Decimal}",
15
               "quantity
Quantity

Quantity of the shipping advice item

": "{Decimal}",
16
               "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

": "{Decimal}",
17
               "endCustomer
EndCustomer

End customer

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

": {
18
                    "customerId
CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

": "{Integer}",
19
                    "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

": "{String}",
20
                    "firstName
FirstName

Secondary name of a company or firstname of a person

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

": "{String}",
21
                    "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

": "{String}",
22
                    "customerLink
CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.EndCustomer in your request URI to get this field

": "{String}"
23
               },
24
               "price": {
25
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
26
                    "discount
Discount

The discount for the item.

": "{Decimal}",
27
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}",
28
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
29
               },
30
               "priceConverted
PriceConverted

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.PriceConverted in your request URI to get this field

": {
31
                    "currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.PriceConverted in your request URI to get this field

": "{String}",
32
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.PriceConverted in your request URI to get this field

": "{Decimal}",
33
                    "netPrice
NetPrice

Final price per unit after deducting all discounts.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.PriceConverted in your request URI to get this field

": "{Decimal}"
34
               },
35
               "totals": {
36
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
37
                    "discountAmount
DiscountAmount

The items discount amount.

": "{Decimal}",
38
                    "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

": "{Decimal}",
39
                    "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}",
40
                    "remainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

": "{Decimal}"
41
               },
42
               "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

": {
43
                    "currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

": "{String}",
44
                    "grossAmount
GrossAmount

Total gross amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

": "{Decimal}",
45
                    "netAmount
NetAmount

Total net amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

": "{Decimal}",
46
                    "remainingAmount
RemainingAmount

Total remaining amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.TotalsConverted in your request URI to get this field

": "{Decimal}"
47
               },
48
               "measurementUnit": {
49
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

": "{Integer}",
50
                    "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
51
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
52
               },
53
               "product": {
54
                    "productId
ProductId

Product identifier

": "{Integer}",
55
                    "name
Name

Name of the product

": "{String}",
56
                    "type
Type

Type of product

Possible domain values can be found here

": "{String}",
57
                    "manufacturer": {
58
                         "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
59
                         "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
60
                    },
61
                    "productLink
ProductLink

Product reference

": "{String}"
62
               },
63
               "landedCost": {
64
                    "grossPrice
GrossPrice

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

": "{Decimal}",
65
                    "purchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

": "{Decimal}"
66
               },
67
               "landedCostConverted
LandedCostConverted

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.LandedCostConverted in your request URI to get this field

": {
68
                    "grossPrice
GrossPrice

Total cost (landed cost or true cost) in sales currency

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.LandedCostConverted in your request URI to get this field

": "{Decimal}"
69
               },
70
               "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": {
71
                    "generalLedgerAccount
GeneralLedgerAccount

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": {
72
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": "{Integer}",
73
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": "{String}"
74
                    },
75
                    "department
Department

The department related to the item. One of the system/fixed account dimensions.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": {
76
                         "departmentId
DepartmentId

Department identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": "{Integer}",
77
                         "departmentLink
DepartmentLink

Finance department reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": "{String}"
78
                    },
79
                    "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": {
80
                         "financeProjectId
FinanceProjectId

Finance project identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": "{Integer}",
81
                         "financeProjectLink
FinanceProjectLink

Finance project reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Accounting in your request URI to get this field

": "{String}"
82
                    }
83
               },
84
               "highlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": {
85
                    "notificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{Integer}",
86
                    "status
Status

Status of the notification

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{Integer}",
87
                    "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{Datetime}",
88
                    "message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{String}",
89
                    "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{String}",
90
                    "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": {
91
                         "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{String}",
92
                         "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{String}",
93
                         "notificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{String}"
94
                    },
95
                    "notificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{String}"
96
               },
97
               "shippingAdvice": {
98
                    "shippingAdviceId
ShippingAdviceId

Shipping advice identifier

": "{Integer}",
99
                    "type
Type

Type of shipping advice. Gives an indication of what this shipping advice is based on or forwarded from.

Possible domain values can be found here

": "{String}",
100
                    "customer": {
101
                         "customerId
CustomerId

Customer identifier

": "{Integer}",
102
                         "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
103
                         "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
104
                         "customerLink
CustomerLink

Customer reference

": "{String}"
105
                    },
106
                    "shippingAdviceLink
ShippingAdviceLink

Shipping advice reference

": "{String}"
107
               },
108
               "rental
Rental

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Rental in your request URI to get this field

": {
109
                    "serialNumberSpecification
SerialNumberSpecification

For shipping advice items of type RENTALORDER, each item can have a serial number specified.

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Rental in your request URI to get this field

": {
110
                         "serialNumber
SerialNumber

Serial number

This field is greyed out because it is an expandable field. You have to add $expand=ShippingAdviceItem.Rental in your request URI to get this field

": "{String}"
111
                    }
112
               },
113
               "shippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

": "{String}"
114
          }
115
     ],
116
     "paging
Paging

Detailed paging information for this list.

": {
117
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
118
          "position
Position

Position of the first element in the list

": "{Integer}",
119
          "page
Page

Page index

": "{Integer}",
120
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
121
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
122
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
123
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
124
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
125
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
126
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
127
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
128
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
129
     }
130
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100147 HTTP 404 Notification type not found